home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfiretrv.zip / SFIRETRV.DOC < prev    next >
Text File  |  1990-06-03  |  11KB  |  246 lines
  1.                                  
  2.                                    SFIRETRV 
  3.                                   Version 1.0
  4.                                  by  Walt Bush
  5.                                The Rossmoyne Mall
  6.  
  7.    INTRODUCTION
  8.    ------------
  9.      SFIRETRV is a fast paced trivia game designed to run as a door feature
  10.    within the SPITFIRE Bulletin Board System version 2.9. Which makes this
  11.    file share compatable.  A data file containing 235 trivia questions is
  12.    randomly accessed and displayed tho the screen. With each question that
  13.    is displayed, four multiple choice options are provided from which the
  14.    player may select their answer.  SFIRETRV allows the player ten seconds
  15.    to read the question and respond with the number corresponding to the
  16.    answer they believe is correct.
  17.     
  18.    SETUP
  19.    ------
  20.       To set up SFIRETRV to be executed as a door, it is recommended that
  21.    a separate directory be set up for it.  For explanation purposes, let's
  22.    assume the directory DOOR_A is created for use with SFIRETRV. The following
  23.    files must then be placed in the directory:
  24.    
  25.    SFIRETRV.EXE   The actual game program.
  26.    
  27.    SFIRETRV.DAT   The data file containing the trivia questions.
  28.    
  29.    SFIRETRV.TOP   This is a listing of the top ten players.  SFIRETRV.EXE
  30.                    will create this file if it is not found. 
  31.    
  32.    The Sysop will then need to use a text editor to edit the SF.BAT file   
  33.    as illustrated below:
  34.    
  35.    :DOOR_A
  36.    COPY SFDOORS.DAT C:\SF\DOOR_A
  37.    CD\SF\DOOR_A
  38.    SFIRETRV
  39.    ERASE SFDOORS.DAT
  40.    CD\SF
  41.    GOTO LOOP
  42.  
  43.    You will notice that the commands needed to execute SFIRETRV are placed
  44.    between the :DOOR_A and GOTO LOOP command lines.  These are entered in
  45.    place of the existing REM Place Program Name Here.  The following will 
  46.    briefly explain each of the commands which were set up within SF.BAT to 
  47.    run SFIRETRV as a  SPITFIRE door program:
  48.    
  49.       SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  50.    door.  It contains information about the user such as name and password.
  51.    SFIRETRV reguires access to the information within SFDOORS.DAT, Therefore,
  52.    before executing the program it must be copied to the directory in which
  53.    SFIRETRV is running.
  54.    
  55.      SFIRETRV is the program name and executes the game program from within
  56.    the door program.
  57.    
  58.       Once the user has terminated the game play of SFIRETRV the SF.BAT file
  59.    erases the SFDOORS.DAT file.
  60.  
  61.  
  62.    SFIRETRV SETUP AS A SYSOP CONFIGUREABLE COMMAND
  63.    --------------------------------------------- 
  64.  
  65.       SPITFIRE has a sysop configurable command for the Main, Message and
  66.    File menus.  The sysop configurable command is executed through a
  67.    batch file which corresponds to the menu it is being run from.  In
  68.    other words, SFMAIN.BAT runs the sysop configurable command from
  69.    the Main Menu, SFMESS.BAT runs the one from the Message Menu and
  70.    SFFILE.BAT the one from the File Menu.  The commands necessary
  71.    to execute SFIRETRV can be setup in the batch file which corresponds
  72.    to the menu you wish to have SFIRETRV run from.
  73.  
  74.       The first thing you will need to establish is which of these menus
  75.    you wish to use to run SFIRETRV  For this purpose, let's assume that
  76.    it is going to be set up so it can be run from the Main Menu.  (It
  77.    should be noted the set up procedure is the same regardless of which
  78.    Menu you are running SFIRETRV from.)
  79.  
  80.       Next, you will need to decide what you wish to name the command
  81.    option and establish what security level will be required for
  82.    users of your system to be able to access this option.  Once this
  83.    is determined you will need to modify the SFMAIN.MNU file using
  84.    your favorite text editor, as long as it saves in ASCII format.
  85.    (Refer to the SPITFIRE manual for further documentation on this
  86.    if needed.  It should also be noted that if SFIRETRV were being
  87.    set up to run from the File Menu, you would need to modify the
  88.    SFFILE.MNU file and if it was being set up to be run from the
  89.    Message Menu you would need to modify the SFMSG.MNU file.)
  90.  
  91.  
  92.       Examining the default SFMAIN.MNU file, you will notice the sysop
  93.    configurable command appears as:
  94.  
  95.         <K>............. Add Your Own,,1000,@
  96.  
  97.  
  98.       This will need to be replaced with a Command Character that will
  99.    be used to select the option from the menu.  It is ASOLUTELY IMPERATIVE
  100.    that the Command Character must not duplicate an existing Command
  101.    Character for another menu option.  You will then need to include
  102.    a brief description of the Wildcat door program you are running, two
  103.    commas, the security level required to access this feature, and another
  104.    comma followed by the a @.  The @ must not be changed! (For more detailed
  105.    information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  106.    to your SPITFIRE manual.)
  107.     
  108.        <K>.... Brief Program Description,,10,@
  109.  
  110.  
  111.       Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  112.    so that it can be executed from the Main Menu.  Do this using your
  113.    favorite text editor, as long as it saves in ASCII format.  (Again, it
  114.    should be noted that if SFIRETRV were being setup to run from the File
  115.    Menu, you would need to modify the SFFILE.BAT file and if it was being
  116.    set up to be run from the Message Menu you would need to modify the
  117.    SFMESS.BAT file.)
  118.  
  119.      Place the SFIRETRV.EXE file in the directory you wish to run the
  120.    program from. SFIRETRV will create its own player score file,
  121.    SFIRETRV.TOP if does not already exist.
  122.  
  123.       The commands set up in the SFMAIN.BAT file are very similar to
  124.    those used for executing the game through a door in the SF.BAT file.
  125.    For instance, if you were running SFIRETRV from the main SPITFIRE
  126.    directory your SFMAIN.BAT file might look like this:
  127.  
  128.        ECHO OFF
  129.        BRK OFF
  130.        SFIRETRV
  131.        BRK ON
  132.  
  133.       (BRK is not included in the SPITFIRE package because it is written
  134.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  135.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of 
  136.    other BBS systems.  BRK is not required to run SFIRETRV, however it
  137.    is recommended since it will prevent a user using the CTRL BRK command 
  138.    to terminate the batch file, gaining access to your system at the 
  139.    DOS level.)
  140.  
  141.       If you wish to set SFIRETRV up in a seperate subdirectory from
  142.    SPITFIRE, for instance, a subdirectory named SFIRETRV, your batch
  143.    file might look like this.
  144.  
  145.        ECHO OFF
  146.        BRK OFF
  147.        COPY SFMAIN.DAT \SF\SFIRETRV
  148.        CD \SF\SFIRETRV
  149.        SFIRETRV
  150.        ERASE SFMAIN.DAT
  151.        CD \SF
  152.        BRK ON
  153.  
  154.  
  155.       When SFIRETRV is executed from either the door with the SF.BAT file
  156.    or from the sysop configurable command through a menu with the
  157.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  158.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  159.    SFDOORS.DAT file.  It will look for each of these files until it finds
  160.    it and the commands required for its execution.  If none of these
  161.    files are found, SFIRETRV will halt its execution
  162.    
  163.  
  164.    LOCAL PLAY OF SFIRETRV
  165.    ---------------------
  166.  
  167.       It should also be noted that a Sysop can play SFIRETRV locally by
  168.    entering the following command at the DOS prompt:
  169.    
  170.    C:> SFIRETRV /L
  171.  
  172.  
  173.    DTE LOCK FEATURE
  174.    ----------------
  175.  
  176.      SFIRETRV automatically detects if the DTE is locked at 19200 baud.  If
  177.    SFIRETRV detects that the DTE is locked, then SFIRETRV opens the serial
  178.    port to the maximum baud rate of your system.  If SFIRETRV does not
  179.    detect that the DTE is locked, then the serial port is opened to the
  180.    baud rate of the caller.
  181.  
  182.      
  183.    SFIRETRV EXECUTION
  184.    ------------------
  185.       
  186.    When first executed, SFIRETRV will display a list of the Top Ten high
  187.    score players and the percentage of correct responses they acheived
  188.    while playing SFIRETRV  Initially, this will be a dummy listing with
  189.    ten lines that display:
  190.    
  191.       0%...............YOUR NAME COULD BE HERE
  192.       
  193.    However, as the game is played, this will fill with the name of the
  194.    players and their percentage ratings.  
  195.    
  196.    NOTE: At least twenty questions must be attempted before SFIRETRV will
  197.    figure the percentage rating for the player.
  198.          
  199.    To keep things interesting...the Sysop can erase the file which contains
  200.    the top ten listings SFIRETRV.TOP on a routine basis to give additional
  201.    players a chance to have their name added to the list.
  202.    
  203.    As the top ten list is displayed, at the bottom of the screen  is a
  204.    question which prompts the user whether they want to have ANSI Graphics
  205.    (y/n)? available to them during game play.  If the user responds with a
  206.    y (for yes) the game will display in color and if the user responds with
  207.    a n (for no) the game will display in monochrome.
  208.    
  209.    ------------------------------------------------------------------------
  210.    
  211.       
  212.         SFIRETRV.ZIP is distributed as FREEWARE software. You are free to
  213.    use, copy,or share with no restrictions!
  214.    
  215.                              Have Fun & Enjoy
  216.                              Walt Bush
  217.                              The Rossmoyne Mall
  218.                              Located in Cincinnati, Ohio
  219.                              Home of the first professional
  220.                              full time Fire Department!
  221.    ----------
  222.    DISCLAIMER
  223.      Walt Bush shall not be held responsible for any damage incurred
  224.    by the user to hardware, software, or peripheral devices while running
  225.    SFIRETRV. All responsibility belongs to the user of the software.
  226.    
  227.    
  228.       Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  229.    225-8496 for his assistance.  Without his help this program would not
  230.    have been possible.   
  231.  
  232.  
  233.    SFIRETRV and other SPITFIRE programs are available for download from:
  234.    
  235.         Buffalo Creek BBS                     The Mother Board BBS
  236.         Sysop - Mike Woltz                   Sysop - Jacque Shipley
  237.           (515) 225-8496                         (515) 986-3445
  238.        19200/9600/2400/1200                      9800/2400/1200
  239.  
  240.                              The Rossmoyne Mall
  241.                              Sysop - Walt Bush
  242.                              (513) 793-9257
  243.                            19200/9600/2400/1200
  244.                                  676 Megs
  245.  
  246.